Home
API reference
Platform API reference
Platform API
Transaction Usage
Get transaction metrics by Redox product

Get transaction metrics by Redox product

get/v1/organizations/{organizationId}/product-classifications/{productClassificationId}/transaction-metrics/connections
Page View

Transaction usage endpoints allow you to review and export transaction usage data for your current Redox contract. This allows you to easily monitor your usage and limits as you go.

You can get details for all the Redox product(s) in your contract, retrieve metrics by product type, and export metrics.

Get transaction metrics by Redox product

Retrieve transaction usage metrics for one of your organization's Redox products for a particular time range. Metrics include counts of total transactions or transactions over time.

You can modify the query by date range and duration (i.e., day or month). 

Request parameters

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/organizations/{organizationId}/product-classifications/{productClassificationId}/transaction-metrics/connections' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json'

Response fields and example

Example payload generated from schema
1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "startDate": "2023-01-01T00:00:00.000Z",
7
    "endDate": "2024-01-01T00:00:00.000Z",
8
    "aggregateBy": "day",
9
    "productClassificationId": "d222fc9e-039a-4486-8be4-cdebcc4c9a06",
10
    "aggregateMetrics": {
11
      "totalCount": 21478
12
    },
13
    "connectionStats": [
14
      {
15
        "connectionId": 122,
16
        "name": "Redox Org",
17
        "aggregateMetrics": {
18
          "totalCount": 21478
19
        },
20
        "dataPoints": [
21
          {
22
            "startDateTime": "2023-01-01T00:00:00.000Z",
23
            "endDateTime": "2023-02-01T00:00:00.000Z",
24
            "count": 9056,
25
            "cumulativeSum": 36803
26
          }
27
        ]
28
      }
29
    ]
30
  }
31
}

    Contains the payload and metadata returned for Get transaction metrics by Redox product.

  • meta
    object
    • version
      string

      Lists the major and minor version number for the format of the returned payload. The payload format or shape may change between minor versions, like including additional or extended fields in later versions. We include the version data in each response so that you have the option to handle the signaled differences.

  • payload
    object
    • startDate
      string

      Contains the date-time in ISO 8601 format to define the start of the date range for results.

    • endDate
      string

      Contains the date-time in ISO 8601 format to define the end of the date range for results. The end date-time is exclusive, which means results may be returned up to this date-time, but not including it.

    • aggregateBy
      string

      Defines the time window for grouping individual logs together, whether by day or month.

      Possible Values: day, month
    • productClassificationId
      string

      Displays the Redox product classification ID that the metrics pertain to.

    • aggregateMetrics
      object

      Contains the properties for aggregate value metrics (e.g., total count).

      • totalCount
        number

        Lists the total count of logs occurring within the date range.

    • connectionStats
      Array of object

      Contains all product connections and their associated log metrics.

      • connectionId
        number

        Displays the connection identifier for the contained metrics.

      • name
        string

        Displays the name of this connection. Usually this is typically your connection's organization name.

      • aggregateMetrics
        object

        Contains the properties for aggregate value metrics (e.g., total count).

        • totalCount
          number

          Lists the total count of logs occurring within the date range.

      • dataPoints
        Array of object

        Contains the over-time data points within the specified time range for this connection.

        • startDateTime
          string

          Contains the date-time in ISO 8601 format to define the start of the date range for this data point.

        • endDateTime
          string

          Contains the date-time in ISO 8601 format to define the end of the date range for this data point. The end date-time is exclusive, which means results may be returned up to this date-time, but not including it.

        • count
          number

          Defines the total count of logs that occurred within the specified date range of this data point.

        • cumulativeSum
          number

          Defines the total sum of logs that have occurred up to the end of this data point's date range, including all prior data points.